/*
 * Copyright 2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.gradle.initialization;

import org.gradle.api.internal.GradleInternal;
import org.gradle.internal.service.scopes.Scope;
import org.gradle.internal.service.scopes.ServiceScope;

/**
 * Responsible creating and configuring the `Settings` object for a newly created `Gradle` instance. The result is passed to a {@link org.gradle.configuration.ProjectsPreparer} to configure the projects.
 *
 * <p>This stage includes running the init scripts and settings script.</p>
 */
@ServiceScope(Scope.Build.class)
public interface SettingsPreparer {
    void prepareSettings(GradleInternal gradle);
}
